WIP: display a kinda-sorta sidebar menu on function reference pages #73
Conversation
There's a lot wrong with this, I hammered junk into place to make something work so we could see if it's worth doing properly.
|
Worth mentioning, I have an experiment PR #75 that moves the search form into the site-title. If this sidebar PR works, we also have the option to move the search control to the top of the sidebar like the block editor. |
|
I'm not really sure if the function list is useful information for the sidebar — what about moving just the table of contents over? That would also fix #76, since the code source would be able to span the full width of the area. Also a note for anyone testing - you need to drop any block/widget into the widget area for the sidebar to appear. |
|
I think you're right that the menu as implemented here isn't the best use of space, but it's not really clear what would be. I thought about putting the inset TOC in the sidebar, but that's inconsistent with the other handbook sections in devhub. And the TOC isn't super useful either. The function list (either by package or by file) could be quite useful, even if it's not in the sidebar. There are some thinly documented functions where there is no good way to discover related functions other than by clicking through to the file view. Having them listed right there on the page would be helpful - like the PHP manual does in the right-hand sidebar. The block-editor handbook does have a function/component reference in its handbook: However the function reference is 10x as large as that handbook, and it would probably be both unwieldy for users and slow. I think all of the sidebar menus are a bit broken really - the fact that you can't navigate to (or even discover) the other handbooks is a major flaw. I think these are mostly separate problems:
|
|
Since WordPress is pretty consistent with naming conventions, could we maybe group by prefix?
|
|
@tellyworth I'll close this issue seeing that we are currently implementing this in the new theme. |
There's a lot wrong with this, I hammered junk into place to make something work so we could see if it's worth doing properly.
Current screenshot:
The menu displays other functions within the same package. There are probably pages where it all goes wrong, I haven't tested widely.
The width of the menu and content is wrong, I haven't figured out why yet.